home *** CD-ROM | disk | FTP | other *** search
/ X User Tools / X User Tools (O'Reilly and Associates)(1994).ISO / sun4c / archive / plan.z / plan / man / cat4 / plan.4
Text File  |  1994-09-18  |  7KB  |  199 lines
  1.  
  2.  
  3.  
  4. PLAN(4L)                                                             PLAN(4L)
  5.  
  6.  
  7.  
  8. NAME
  9.   ~/.dayplan - database file of plan(1L)
  10.  
  11. SYNOPSIS
  12.  
  13. DESCRIPTION
  14.   The ~/.dayplan file is read and written by the plan and pland programs. It
  15.   can be edited manually, but it has not been designed for this. Generally,
  16.   the format is annoyingly unmnemonic, and there is virtually no error check-
  17.   ing. Use at your own risk. The only reason I didn't make this a binary file
  18.   is that I hate binary config files as a matter of principle.
  19.  
  20.   The type of every line depends on the first character of the line. The
  21.   second character is always a single TAB character. All following characters
  22.   are arguments. Comments and blank lines (which are ignored) can appear any-
  23.   where. "Header types" are all at the beginning of the file before the first
  24.   "entry type".
  25.  
  26.   TYPES THAT CAN APPEAR ANYWHERE:
  27.  
  28.   ##    Comment line. The rest of the line is ignored.
  29.  
  30.  
  31.   HEADER TYPES:
  32.  
  33.   oo    Options. The argument consists of 12 consecutive flag characters, and
  34.        five numerical arguments.  In order, the flags are:
  35.  
  36.        ss sunday first
  37.  
  38.        aa 12-hour (am/pm) mode
  39.  
  40.        mm US date format mm/dd/yy
  41.  
  42.        dd auto-delete past options
  43.  
  44.        jj show julian dates
  45.  
  46.        ww show week numbers
  47.  
  48.        nn show the next three notes, rather than the first three
  49.  
  50.        bb numeric warning entry mode, rather than popup mode
  51.  
  52.        ww show advance warnings graphically in week view
  53.  
  54.        uu show user names next to note strings in week view
  55.  
  56.        -- not used, for future extensions
  57.  
  58.        -- not used, for future extensions
  59.  
  60.        -- not used, for future extensions
  61.  
  62.        After the flags, the default advance-warning times that are used when
  63.        the small buttons at the left edge of the advance-warning popup are
  64.        pressed. The first number is the early time, the second the last time.
  65.        Both are in seconds. The third number is the expiration time of notif-
  66.        ier windows; zero or a missing number means the windows live forever,
  67.        any other number is the maximum lifetime in seconds.  The fourth and
  68.        fifth numbers are the hours at the left and right margin of the week
  69.        view; defaults are 8 and 20.
  70.  
  71.   tt    Time adjustment parameters as defined with the Adjust Time popup. The
  72.        five numeric parameters are the offset to the system clock in seconds,
  73.        the timezone offset in seconds, the DST flag (0=always on, 1=always
  74.        off, 2=automatic), and the Julian begin and end dates for automatic
  75.        DST.
  76.  
  77.   ee    Early warning flags,
  78.  
  79.   ll    Late warning flags, and
  80.  
  81.   aa    alarm flags:
  82.        These three have the same format. The first three argument chars are
  83.        flags, as specified in the Alarm Options popup. '-' means the flag is
  84.        off, everything else means the flag is on. In order, the flags are:
  85.  
  86.        ww show a color-coded window when the warning/alarm triggers
  87.  
  88.        mm send mail when the warning/alarm triggers
  89.  
  90.        xx execute a command when the warning/alarm triggers
  91.  
  92.        The flags are followed by a single blank. The rest of the line is the
  93.        command to execute when the warning/alarm triggers and the 'x' flag is
  94.        on.
  95.  
  96.   pp    The print spooling string. When printing a PostScript calendar, the
  97.        PostScript code is sent to stdin of this command.
  98.  
  99.   mm    The mailer program, as specified in the Alarm Options menu. Up to one
  100.        "%s" is allowed, it is replaced by the (quoted) note string.  "%s" is
  101.        typically used for a subject.
  102.  
  103.   UU    Global user list parameters. Currently, there is only one integer
  104.        argument; the number of users (the number of 'u' lines following).
  105.        The user list is the list of "friends" whose public appointments
  106.        appear in the week view.
  107.  
  108.   uu    One user in the user list. There are four arguments:
  109.  
  110.        -- the user name
  111.  
  112.        -- the user's home directory
  113.  
  114.        -- 0 if the user is shown, 1 if the user is suspended
  115.  
  116.        -- the color used in the week view, a number in the range 0..7
  117.  
  118.  
  119.   ENTRY TYPES:
  120.  
  121.   [[00--99]]
  122.        Begins an entry. This is the only mandatory line, all others that fol-
  123.        low are optional. All following lines that do not begin with a numeric
  124.        digit are extra information for the entry. Unlike all other types,
  125.        there is no TAB character in the second column, the first character is
  126.        the first digit of the trigger date.
  127.  
  128.        The line consists of five date/time fields, seperated by at least one
  129.        blank, and three flag characters that must be consecutive. As usual,
  130.        flags are off if the character is '-', and on otherwise. The fields
  131.        are:
  132.  
  133.        11//22//33    trigger date, month/day/year. Year can be either
  134.                 70..99,00..38, or 1970..2038.  Do not enter appointments
  135.                 after 2037. If there is demand, I'll fix this bug in about 45
  136.                 years.
  137.  
  138.        11::22::33    trigger time, hour:minutes:seconds, in 24-hour format.
  139.                 99:99:99 means that there is no alarm time ("-" in the time
  140.                 column).
  141.  
  142.        11::22::33    length, hour:minutes:seconds, in 24-hour format
  143.  
  144.        11::22::33    early-warning time, hour:minutes:seconds, in 24-hour format,
  145.                 0:0:0 means there is no early warning
  146.  
  147.        11::22::33    late-warning time, hour:minutes:seconds, in 24-hour format,
  148.                 0:0:0 means there is no late warning
  149.  
  150.        SS        suspended (the green button at the left edge is off)
  151.  
  152.        PP        private (goes into the private dayplan file that has mode
  153.                 0600)
  154.  
  155.        NN        no alarm (trigger warnings if nonzero, but no final alarm)
  156.  
  157.   RR    Add repetition information to the current entry. There are five
  158.        numeric fields, separated by at least one blank. This one is particu-
  159.        larly unsuited for human consumption, sorry.
  160.  
  161.        11 trigger alarm every <1> days (in seconds)
  162.  
  163.        22 delete alarm after this date (seconds since 1/1/70 0:00:00)
  164.  
  165.        33 weekday bitmap and nth-week bitmap:
  166.          bit0=sunday ... bit6=saturday
  167.          bit8=first ... bit12=fifth, bit13=last
  168.  
  169.        44 month day bitmap, bit0=last day of the month, bits 1..31=on that day
  170.          of the month
  171.  
  172.        55 if 1, the entry repeats every year; if 0, it doesn't.
  173.  
  174.   NN    Add a note string to the current entry. All characters that follow the
  175.        TAB are part of the note string.
  176.  
  177.   MM    Add another line to the current entry's message. All characters that
  178.        follow the TAB are part of the line. There can be multiple M lines,
  179.        they all add to the message.
  180.  
  181.   SS    Add another line to the current entry's script. All characters that
  182.        follow the TAB are part of the line. There can be multiple S lines,
  183.        they all add to the script.
  184.  
  185.   GG    Reserved for group meetings, not currently used.
  186.  
  187.  
  188.  
  189.  
  190.  
  191.  
  192.  
  193.  
  194.  
  195.  
  196.  
  197.  
  198.  
  199.